home *** CD-ROM | disk | FTP | other *** search
/ Aminet 19 / Aminet 19 (1997)(GTI - Schatztruhe)[!][Jun 1997].iso / Aminet / comm / thor / AminetParse.lha / AminetParse.doc < prev    next >
Text File  |  1997-04-29  |  7KB  |  183 lines
  1.                             AminetParse v1.05
  2.  
  3.                       © 1997 by Daniel J. Andrea II
  4.  
  5.  
  6. NOTE:  This software is offered as GIFTWARE.  If you like it, then you can
  7. send me something in payment of your choice (other programs, disks, 
  8. computers, cars, etc.) at the address at the end of this document.  No
  9. warranty of any kind is offered with this software or implied, or for
  10. suitability of purpose.  It's use is entirely at your own risk.
  11. No fees can be charged for this software, other than the nominal fees for 
  12. the cost of magnetic media and copying of the software onto that media, 
  13. not to exceed the amount of US $5 for a disk containing this software.
  14. Copies of this software must include this documentation file for 
  15. redistribution through Fred Fish or other similar software collections.
  16.  
  17.  
  18. What is it?
  19. ===========
  20.  
  21. AminetParse is a small utility to parse Aminet RECENT or INDEX lists into
  22. Thor's file database.  This is quite a bit faster than the arexx script
  23. supplied with Thor.  I experimented quite a bit with the arexx script, but
  24. the best I could get with it was approximately 22 files added per second.
  25. AminetParse is quite fast.  On my system, it reaches speeds in excess of 
  26. 150 files added per second.  In some cases I've seen it hit peaks of over
  27. 200 files per second!
  28.  
  29. Recent files can be filtered with the Sortmail.excl file, just like in
  30. Sortmail.  Also, as of AminetParse 1.05, a NewFiles.txt file will be
  31. created in the proper directory just like Sortmail does.  This will only
  32. be done on RECENT listings.  AminetParse does absolutely nothing with the
  33. NewFiles.txt file when parsing INDEX listings.
  34.  
  35. Note: NewFiles.txt will be replaced completely every time AminetParse is
  36. run with a RECENT listing.
  37.  
  38. AminetParse requires Thor 2.3+ (at least ver 4 of bbsread.library) and 
  39. AmigaOS 2.04+.
  40.  
  41.  
  42. Installation
  43. ============
  44.  
  45. Well, it's real simple.  AminetParse is a cli-only program, and can be run
  46. from anywhere.  Probably the best place would be in the bin sub-directory
  47. of Thor's main directory.  Just copy it to wherever you want to run it
  48. from.
  49.  
  50.  
  51. Usage
  52. =====
  53.  
  54. AminetParse is a shell-only program.  If you try to start it from the
  55. Workbench, you will most likely crash your machine.
  56.  
  57. Just type AminetParse in a shell and you'll get output like this:
  58.  
  59. AminetParse 1.05 (29-Apr-97) © 1997 Daniel J. Andrea II
  60. Usage:     AminetParse <system name> <Aminet INDEX/RECENT file> EXCLUDE
  61.  where <system name> is name of system to add files to
  62.        <Aminet INDEX/RECENT file> is full path and name of INDEX/RECENT file
  63.        EXCLUDE  (optional) tells AminetParse to use the Sortmail.excl file
  64.                 from inside the BBS's data directory to exclude certain file
  65.                 areas from being added to the database.
  66.  
  67. All you need is the name of your System in Thor, as in EMail&News (that's
  68. my BBS system name), and the full path and name of the INDEX/RECENT file.
  69. For example:
  70.  
  71.   AminetParse EMail&News SYS:temp/INDEX
  72.   
  73. will add the file INDEX from the drawer SYS:temp/ to the file database in
  74. the Thor system EMail&News.
  75.  
  76. Or add EXCLUDE:
  77.  
  78.   AminetParse EMail&News SYS:temp/INDEX EXCLUDE
  79.   
  80. will do the same as the previous example, but will use the Sortmail.excl
  81. file from inside the data directory of the BBS you enter.  If there is no
  82. Sortmail.excl file, AminetParse will continue as if the EXCLUDE option
  83. hadn't been entered along with a warning message.
  84.  
  85. That's it!
  86.  
  87. While AminetParse is running, you will get occasional status messages.
  88. First it will tell you whether this is a RECENT listing, such as daily or
  89. weekly, or a full INDEX. Then it will print out numbers periodically to
  90. show how many files have been processed.  Whenever a file area is parsed
  91. that is not in the file database, it will automatically add it and print
  92. out a message that it did so.
  93.  
  94. When it's finished, AmintParse will print out some statistics about the
  95. file parsing.
  96.  
  97. Note: The file supplied to AminetParse as an INDEX/RECENT listing must not
  98. have any extra info before the first line starting with the "|" character
  99. and containing either the word "Complete" or "Recent".  AminetParse will
  100. check for the existence of that info in the very first line it reads in
  101. from the text file to verify this is an Aminet INDEX/RECENT file listing.
  102. If these items are not present, AminetParse will quit with an error message
  103. without modifying anything in Thor's file database.  I'm going to change
  104. this in the near future, so files with info before the first "|" line will
  105. be ignored by AminetParse.
  106.  
  107.  
  108. Bugs
  109. ====
  110.  
  111. There are no known bugs at this time.  If you find any, please contact me
  112. at the E-Mail address or Snail-Mail address below with bug reports.  Be
  113. sure to include information on what other software was running and what
  114. kind of system you have.  Bug fixes will be incorporated into AminetParse
  115. as soon as possible.
  116.  
  117.  
  118. History
  119. =======
  120.  
  121.    v1.00  --  Initial release.
  122.  
  123.    v1.01  --  Added filtering based on the Sortmail script's filtering.
  124.               AminetParse uses the same file format, and will read the 
  125.               file Sortmail.excl from the BBS's data directory.
  126.    
  127.    v1.02  --  Well, it did have a bug.  Found my date calculation was
  128.               off by a couple of days.  Now shows correct date.
  129.  
  130.    v1.03  --  Added Checking for valid INDEX/RECENT file.  Removed a
  131.               warning message that wasn't needed.  Should fix some
  132.               problems noted by Trevor Daley.
  133.    
  134.    v1.04  --  Changed data calculation again.  This version should work
  135.               better now.
  136.  
  137.    v1.05  --  Added NewFiles.txt creation during parsing of RECENT
  138.               listings.
  139.  
  140.  
  141. Author
  142. ======
  143.  
  144. I can be contacted through Internet E-Mail at:
  145.  
  146.       dandrea@unix.tfs.net
  147.  
  148. or through Snail-Mail at:
  149.  
  150.       Daniel J. Andrea II
  151.       1331 Metropolitan St.
  152.       Leavenworth, KS 66048
  153.       U.S.A.
  154.  
  155. To check up on AminetParse development and other projects when they arise,
  156. point your web browser at
  157.  
  158.       http://www.tfs.net/~dandrea/
  159.  
  160. AminetParse was developed on a 25 MHz A3000 using SAS/C v6.57.
  161.  
  162.  
  163. Future
  164. ======
  165.  
  166. I will be adding an Arexx script to run from Sortmail that uses
  167. AminetParse to do the Aminet Daily/Weekly listings.  When it is finished,
  168. I will add it to the archive and upload a new version to Aminet.
  169.  
  170. Have you got an idea for improvement?  Let me know and I'll see what I can
  171. do.
  172.  
  173.  
  174. Thanks
  175. ======
  176.  
  177. Special thanks to Petter Nilsen of the Thor team for help with my early
  178. version of AminetParse.  I couldn't see the trees in the forest so to
  179. speak, and he helped me sort it out.  Thanks, Petter!
  180.  
  181. Also, thanks to Trevor Daley for pointing out the date calculation 
  182. problems.
  183.